home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pitsb1.zip / PITSTOP.DOC < prev    next >
Text File  |  1992-03-27  |  9KB  |  228 lines
  1.                               ** PITSTOP **
  2.                               By Luis Garcia
  3.  
  4.                               BETA VERSION 1
  5.  
  6.                            SYSOP DOCUMENTATION
  7.  
  8.                         (C)1992 Back Alley SoftWare
  9.  
  10.                               Fido 1:367/27
  11.                              Eggnet 99:9014/5
  12.  
  13.                       Midnight Run BBS (809)720-3833
  14.  
  15. What's Pitstop?
  16.  
  17.         Pitstop is a online Bulletin/Text/Ansi file Displayer. After
  18. having problems with other Art Gallery and trying to organize numerous
  19. top scores from many doors, I decided to create my own program useing
  20. the doorsource modules. Here are some of the Feautres:
  21.  
  22. * Display Text archives from inside .ARJ compressed files.
  23. * Reads straight off from Files.bbs.
  24. * Works as an ANSI Art Gallery for ANSI'S or Top Scores Bulletins.
  25. * Configurable Areas.
  26. * Writes to Log which bulletin was read or an error occured.
  27.  
  28.  
  29.  
  30. Setting up:
  31.  
  32.         Uncompress the files and follow the DoorSource instructions on
  33. Setting up doors. (DS.DOC). Which is also in the file.
  34.  
  35. FILES:
  36.  
  37.         BULLWELL.ANS(.ASC) The Main Display presented when the callers
  38.                            first enters PITSTOP
  39.         BULL.ANS(.ASC)     Main Menu in ANSI or ASCII Format.
  40.         PITSTOP.CFG        Main Configuration File(Explained Below)
  41.         PITSTOP.EXE       Main Executable
  42.         PITSTOP.DOC       What your reading right now!
  43.         DS.DOC             Setting up the File to your BBS Type Doc!
  44.         DS.CFG             DoorSource Example Configuration File.
  45.  
  46. ------------------------------------------------------------------------
  47.  
  48.         Pitstop reads from Files.bbs type format or *.LST files. First
  49. you set up the main configuration file, below is and example which each
  50. line explained.  The File MUST be named PITSTOP.CFG and be in the same
  51. directory as PITSTOP.EXE,
  52.  
  53. * PLEASE ADD BACKSLASH AT THE END OF LINES WHEN DESCRIBING DIRECTORIES.
  54.  
  55. c:\b\text\
  56. c:\bbs\system.log
  57. tVirus Digest (Imported from InterNet)@c:\bbs\virus-l\files.bbs@c:\bbs\virus-l\
  58. tGeneral Bulletins Area #1@c:\bbs\bulletin\files.bbs@c:\bbs\bulletin\
  59. bAnsi Art Gallery: Faces@c:\bbs\gallery\faces.lst
  60. bAnsi Art Gallery: Cartoons@c:\bbs\gallery\cartoons.lst
  61. bAnsi Art Gallery: General ANSI Graphics Vol #3@c:\bbs\gallery\other2.lst
  62. bAnsi Art Gallery: Top Players HI-SCORES!@c:\b\text\players.lst
  63.  
  64. ---------------------------------------------------------------------------
  65.         This is a PURE ASCII file and at least the first three lines
  66. must be entered or the program will abort.
  67.  
  68. First Line : Where BULLWELL.ANS(.ASC) and BULL.ANS(.ASC) are located.
  69. Second Line: Where Pitstop will write the log or errors when a file
  70.              isn't located.
  71. Third line on.... THE Area configuration.
  72.  
  73.  
  74. ANSI FILES:
  75.  
  76.  
  77.  bAnsi Art Gallery: Top Players HI-SCORES!@c:\b\text\players.lst
  78. /\
  79. ||
  80. ===  The first character tells PITSTOP if it must uncompress the file
  81. before reading the file or it's and Ansi file. If the first character is
  82. a (t) (MUST BE IN LOWER CASE!) its a Text (.TXT) file and it must be
  83. uncompressed (Only .ARJ is supported in this version.). If the first
  84. character is (b) it's a (.ANS) or (.ASC) file and doesn't need to be
  85. uncompressed, this is good for a ansi art gallery or displaying doors
  86. created bulletins.!
  87.  
  88. bAnsi Art Gallery: Top Players HI-SCORES!@c:\b\text\players.lst
  89.  |______________________________________|
  90.  
  91.         From the second Character until the First (@) sign is the name
  92. of the area as it will apear in the main menu.
  93.  
  94. bAnsi Art Gallery: Top Players HI-SCORES!@c:\b\text\players.lst
  95.                                          |____________________|
  96.  
  97.         The last description is where PITSTOP can find the file list
  98. containing the file descriptions and the location of the file. (This way
  99. you can have many .ANS or .ASCII all over the disk and still have them
  100. together in the menu.(WOW!). You can use any name, in this case I used
  101. (players.lst), you pick the name... Heres and example of my PLAYERS.LST:
  102.  
  103. Top Fishers@c:\b\text\FISH
  104. Top Combat Players@c:\b\text\COMBAT
  105. Phantasia top Players@c:\b\text\PHANT
  106. Top Players for Trivia@c:\b\text\TRIV
  107. |_____________________|
  108.  
  109.         The first characters until the (@)sign are the description which
  110. will appear on PITSTOP after selecting an AREA.
  111.  
  112.         The remaining file description is the FULL PATH and name of the
  113. file. you don't have to include an extension (.ANS or .ASC) Pitstop will
  114. automaticly present the file according to the ANSI setting of the user.
  115.  
  116. Got it?, Let go see how it's done if it's a Text file...!!!
  117.  
  118. TEXT FILES:
  119.  
  120. tGeneral Bulletins Area #1@c:\bbs\bulletin\files.bbs@c:\bbs\bulletin\
  121.  
  122.         As before the first character tells PITSTOP that it's a TEXT
  123. file configuration line. The next Characters until the next (@) sign
  124. contain the file with the TEXT descriptions, in this case I'm using the
  125. FILES.BBS from Superbbs(or QuickBBS). You must append the the file
  126. description a (T) to tell pitstop that it's a text file, an example is
  127. provided below. FILES.BBS:
  128.  
  129.                    SOUND BLASTER DIGEST (Published Montly)
  130.  
  131.  ╔════════════╦═══════╦════════╦══════════════════════════════════════════╗
  132.  ║  NAME      ║  SIZE ║  DATE  ║ DESCRIPTION                              ║
  133.  ╚════════════╩═══════╩════════╩══════════════════════════════════════════╝
  134.  
  135. SBD0011.ARJ  (T)Sound Blaster Digest #11 (Oct. 1991)
  136. SCAN86B.ARJ  McFee Scan V86 Scan program.
  137. SBD0013.ARJ  (T)Sound Blaster Digest #13 (Dec. 1991)
  138. SBD0014.ARJ  (T)Sound Blaster Digest #14 (Jan. 1992)
  139.              |_|
  140.               |
  141.               |
  142.  You Must ADD THIS for Pitstop to recognize the line! (This way you can
  143.  call files.bbs. and have files still available for downloading
  144.  When this menu is presented only lines with a (T) are
  145.  shown and in this case SCAN86B.ARJ is not shown as an option. (WOW!)
  146.  
  147. * If your not running SuperBBS or any other BBS that's supports this
  148. type of format (FILES.BBS) you may create a separate file as long as the
  149. file is in similar format.
  150.  
  151.         NAME OF FILE (WITH EXTENCION), few Spaces.., Description with
  152.         (T) prefixed. As the example above.
  153.  
  154.  
  155. tGeneral Bulletins Area #1@c:\bbs\bulletin\files.bbs@c:\bbs\bulletin\
  156.                                                      |_______________|
  157.  
  158.         The last description is the Path of where the files can be
  159. found. This way you can have many Description files in a directory and
  160. the files in others. (Most of the time these two are the same...) I
  161. added it just in case you don't wish certain files to be able to be
  162. downloaded... DON'T FORGET THE BACKSLASH!
  163.  
  164. IMPORTANT!
  165.  
  166.         The file to be read inside the COMPRESSED file must be the same
  167. name but with .TXT extension for example: Here' whats inside SBD0014.ARJ
  168.  
  169. ARJ 2.30NG Copyright (c) 1990-92 Robert K Jung. Jan 19 1992
  170. NOT REGISTERED for business, commercial, or government use.
  171.  
  172. Processing archive: SBD0014.ARJ
  173. Archive date      : 1992-02-17 22:50:42
  174. Filename       Original Compressed Ratio DateTime modified CRC-32   AttrBTPMGVX
  175. ------------ ---------- ---------- ----- ----------------- -------- -----------
  176. WHITERM2.CMF      14924       1314 0.088 91-05-19 19:58:54 917147C3 A--W B 1   
  177. SBDBBS.TXT         6609       3300 0.499 92-01-09 00:45:52 0A13B6D6 A--W B 1   
  178. SBD-AD.ANS         2146        534 0.249 91-08-12 21:16:02 9FC0264D A--W B 1   
  179. SBD0014.TXT       56744      17660 0.311 92-01-09 00:32:04 8560D21F A--W B 1   
  180. GREATONE.TXT        448        241 0.538 91-01-01 04:44:32 114AE4F8 A--W B 1   
  181. ------------ ---------- ---------- -----
  182.     5 files       80871      23049 0.285 
  183.  
  184.       Pitstop will uncompress only SBD0014.TXT and display it to the USER,
  185. after the file is displayed it's deleted.
  186.  
  187. FILES: (BULLWELL.ANS AND BULL.ANS)
  188.  
  189.    Bullwell.ANS (.ASC) should contain information about your BBS and what's
  190. pitstop all about.
  191.  
  192.         BULL.ANS(.ASC) MUST contain the main menu and three options.
  193.  
  194.  
  195.         (C)hange area (this will list the areas you defined in the
  196.            PITSTOP.CFG area. Pitstop will display in Blue areas which
  197.            are Ansi files, in this case areas which are configured as
  198.            (b) in the PITSTOP.CFG.
  199.  
  200.         (R)ead Bulletins from the Current list. Pitstop will default to
  201.            the first defined area.
  202.  
  203.         (M)ain Menu, This will exit PITSTOP and return to the BBS.
  204.  
  205.  
  206.         (*)Will also return to the BBS.
  207.  
  208.  
  209.  
  210. Well that's it!
  211.  
  212.         If you have any trouble please leave a Netmail at one of the
  213. following Addreses:
  214.  
  215.         Luis Garcia     1:367/27 FidoNet
  216.                         8:999/24 RBBSNET
  217.                       43:1395/107 SuperNet
  218.                       99:9014/5   Eggnet
  219.                     500:500/10 EtherLink
  220.  
  221.         L_GARCIA@RACIN.CLU.NET Internet or
  222.         L_GARCIA@USCAC1!upr1.upr.clu.edu
  223.  
  224.  
  225.  
  226.  
  227.  
  228.